home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / fido / gfreq15.lha / GFreq1.5 / Docs / GFreq_EN.doc next >
Text File  |  1994-09-23  |  16KB  |  380 lines
  1.  
  2.     GoldFreq version 1.5
  3.     
  4.     GoldFreq is shareware and copyright Jari Kanerva.
  5.     The author can be reached at Fidonet 2:201/411.73 or 2:203/319.7
  6.     e-mail jari@p73.anet.bbs.bad.se
  7.     snailmail
  8.         Jari Kanerva
  9.         Njurundagatan 6
  10.         162 29  VÄLLINGBY
  11.         SWEDEN
  12.  
  13.     You will always find the latest version of GoldFreq for filerequest
  14.     from The Reptile House 2:203/424.0 Magic name GoldFreq.
  15.  
  16.         Introduction:
  17.     GoldFreq is a FidoNet-compatible filerequest server. It has nodelist
  18.     support. Sends Netmail or response file to the freqqing system.
  19.     Supports Softlinks. Checks that volymes in GoldFreq-cfg exists before
  20.     trying to use them thats to avoid the DOS-requester "Please insert
  21.     Volyme xx in any drive." GoldFreq handles points, magicfiles,
  22.     updatefreq's, userlevels, password's and much more.
  23.  
  24.     The registered version has also
  25.     Special password's for the sysop and possibility to make statistics.
  26.  
  27.     All configuration keywords and features are explained later in this
  28.     document.
  29.     
  30.     GoldFreq is shareware, and may be distributed in a non-commercial way
  31.     (you may copy, spread, and use it but don't make money out of it).
  32.  
  33.     The programmer take no responsibility for eventual errors that the
  34.     program may create in any way. You run it on your own risk. I have
  35.     done everything I can to assure that it functions correctly. Many hours
  36.     of testing and debugging have been done. (If you still find any bugs,
  37.     please report).
  38.  
  39.     The keyfile that You get when You register is commercial and strictly
  40.     personal and may not be spread.
  41.  
  42.     I have only tested GoldFreq with TrapDoor, but it work just as fine
  43.     with other similar programs.
  44.     GoldFreq nedds a few arguments from TrapDoor when it is started.
  45.     If You use Trapdoor then put in the line
  46.     FREQUEST "GoldFreq %i %o %O \"%S\" %n %A" in TrapDoor.cfg or if You not have
  47.     the coniguration file in "Mail:" then use the line
  48.     FREQUEST "GoldFreq %i %o %O \"%S\" %n %A c=<path/cfgfile>" in TrapDoor.cfg
  49.     %i = The name of the .req file.
  50.     %o = The name of the .rlo file.
  51.     %O = The path to your outbound directory
  52.     %S = The name of the sysop that sends the request.
  53.     %n = The Fidonet-address of the requesting system.
  54.     %A = The AKA's of the requesting system (this is not necessary).
  55.     OBS If You don't have the programm-file GoldFreq in your path You must
  56.     put the filepath in TrapDoor.cfg.
  57.     Ex: FREQUEST "mail:bin/GoldFreq %i %o %O \"%S\" %n %A"
  58.  
  59.     To be able to check if the requesting node is in the nodelist. GoldFreq
  60.     needs the traplist compilled nodelist and traplist.library version 5 or
  61.     above
  62.  
  63.     TrapDoor is copyright Maximilian Hantsch and Martin Laubach.
  64.     
  65.     GoldFreq is offered to you under the concepts of ShareWare. You can
  66.     use it for an evaluation period of up to 30 days without paying any
  67.     charge. If you are going to use Spot after the evaluation period, you
  68.     should register.
  69.  
  70.     Taglines, Syspass, FileAccounting, AllMagic, Possibility to specify
  71.     multiple files with the same magicname and to use wildcard in the
  72.     magicfiles are only possible in the registered version.
  73.     You can send max 3 files with the oregistered version.
  74.  
  75.     You can register by sending 100 SEK or 20 US$ to:
  76.         Jari Kanerva
  77.         Njurundagatan 6
  78.         162 29  VÄLLINGBY
  79.         SWEDEN
  80.     In Sweden You can use POSTGIRO: 836 86 57 - 6, 100 SEK.
  81.     Please state your full name and address. Your fidonetaddres and that
  82.     you wish to register GoldFreq.
  83.     I will make a fileattatch with your keyfile to the fidonetaddres you
  84.     give me. Or if it don't succed I will UUEncode it in a Netmail to You.
  85.  
  86.     The keyfile that you get when you register is commercial and may not
  87.     be spread. If you sell your keyfile you are not allowed to keep any
  88.     copy of the keyfile.
  89.     GoldFreq.key must be in the same directory as the file GoldFreq or in
  90.     Mail:
  91.  
  92.     I wish to thank
  93.     Kjell Cederfeld for much help, many good ideas and betatesting.
  94.     Christian Carlsson for many good ideas and betatesting. And great
  95.     patience with a program that did not start on his computer.
  96.  
  97. ===========================================================================
  98.  
  99.  
  100.         Let's take a look at the configuration file.
  101.  
  102.         Keyword: SYSOP <Name>
  103.     Here you just write your own name.
  104.     Ex: SYSOP Jari Kanerva
  105.  
  106.         Keyword: NODE <nodenummer>
  107.     Here you write your fidonetadress. It must be your full 4d
  108.     fidonetaddress.
  109.     Ex: NODE 2:203/319.7
  110.  
  111.         Keyword: SYSTEM <name>
  112.     This is the name of your system/BBS.
  113.     Ex: SYSTEM The Cybers Heaven
  114.  
  115.         Keyword: (NO)FILEACC
  116.     If You wish to keep accounting on how many times each file has been
  117.     requested. It will also be writen in the netmail or the responsfile.
  118.     This require that ACCPATH <dir> is set.
  119.     This works only on the registered version.
  120.     Ex: FILEACC
  121.  
  122.         Keyword: (NO)ACCPATH <dir>
  123.     If You wich to keep accounting of how much each node freq from You.
  124.     Then you have to give GoldFreq a path where it can keep its accounting
  125.     files.
  126.     Ex: ACCTPATH  Mail:GFreq/Accounts
  127.  
  128.         Keyword: (NO)LOGFILE <file>
  129.     Tell GoldFreq what to call its logfile.
  130.     Ex: LOGFILE Mail:GFreq/GFreq.Log
  131.  
  132.         Keyword: (NO)NODELIST <dir>
  133.     Tell GoldFreq where to find the nodelist.
  134.     Ex: NODELIST Mail:Nodelist
  135.  
  136.         Keyword: DATABASE <dir>
  137.     This is a directory that GoldFreq needs for its internal files.
  138.     Ex: DATABASE mail:GFreq/Database
  139.  
  140.         Keyword: WORKDIR <dir>
  141.     This is the directory where Goldfreq can put its temporary files.
  142.     Ex: WORKDIR T:
  143.  
  144.         Keyword: (NO)LOCALMSG
  145.     Tell GoldFreq to send a Netmail to the requesting node. With among
  146.     other things the result to the filerequest.
  147.     Ex: LOCALMSG
  148.  
  149.         Keyword: (NO)RSP
  150.     Tell GoldFreq to send a response file instead of the netmail.
  151.     Ex: RSP
  152.  
  153.         Keyword: (NO)HEADER <file>
  154.     File to get the netmail or rspfile header from. In the header file you
  155.     should put some information of your system.
  156.     Ex: HEADER Mail:GFreq/GFreq.Header
  157.  
  158.         Keyword: (NO)FIRSTCALL <file>
  159.     Select a firstcall file to send to those nodes that request files for
  160.     the first time. Telling more abaut your system than the header file.
  161.     Ex: FIRSTCALL Mail:GFreq/textfiles/FirstTime.TXT
  162.  
  163.         Keyword: (NO)TAGS <file>
  164.     Tell GoldFreq that you wish to use taglines. And where to look for
  165.     them.
  166.     If the tagline contains "\n" then there will be an newline in the
  167.     letter.
  168.     This works only on the registered version.
  169.     Ex: TAGS Mail:Gfreq/Tags
  170.  
  171.         Keyword: (NO)SYSPASS <password/file>
  172.     This is a special password for the sysop. By using the SYSPASS the
  173.     sysop may request files that do not exist in the areas specified in
  174.     GoldFreq.cfg or request files from nodes that normaly are not allowed
  175.     to make filerequests. You may choose one alltime password by putting
  176.     the password in GoldFreq.cfg or select a file to get the password from
  177.     by just putting <path/file> in GoldFreq.cfg. If you choose to have the
  178.     file then you can use each password just once. When the password is
  179.     used GoldFreq marks it with a space before the password so that it
  180.     can't be used again before the space is removed manually. When the
  181.     first password is marked used GoldFreq selects the second and so on.
  182.     When al the passwords in the file is used then you won't be able to use
  183.     SYSPASS again until you have remowed the spaces and marked the
  184.     passwords unused again.
  185.     After three failed attempts to use SYSPASS GoldFreq puts a file named
  186.     NOSYSPASS in the directory you have specified as DATABASE. As long as
  187.     the file is there you won't be able to use syspass. The file must be
  188.     removed manually.
  189.     if you send two failed SYSPASS and then one succesfull the counting
  190.     starts from zero and you have three atempts again.
  191.     In the requestfile you shall write:
  192.     On the first line you must write: SYSPASS <yourpassword>
  193.     On the foliwing lines you can write like a normal filerequest if the
  194.     files are in some of the paths specified in Goldfreq.cfg otherwise if
  195.     the files are some where else. Then you must write the whole path to
  196.     the file.
  197.     This works only on the registered version.
  198.     Ex cfg: SYSPASS Mail:GFreq/PassWords
  199.     Ex cfg: SYSPASS My_password_is_secret
  200.     Ex Freq: SYSPASS My_password_is_secret
  201.              s:startup-sequence
  202.              GoldFreq
  203.  
  204.         Keyword: (NO)FAILSYSPASS <file>
  205.     Textfile to send to those who try to use SYSPASS but fails.
  206.     Ex: FAILSYSPASS mail:GFreq/Textfiles/FailSys.TXT
  207.  
  208.         Keyword: (NO)POINTS
  209.     Allow points to make filerequests.
  210.     Ex: POINTS
  211.  
  212.         Keyword: (NO)FAILPOINT <file>
  213.     Path to textfile to send for failed requests due to NOPOINT option.
  214.     Disable or set NOFAILPOINT if you don't wish to use this.
  215.     Ex: FAILPOINT mail:GFreq/Textfiles/Point.TXT
  216.  
  217.         Keyword: (NO)UNLISTED
  218.     Allow nodes not listed in the nodelist or your private pointlist to
  219.     request files.
  220.     Ex: UNLISTED
  221.  
  222.         Keyword: (NO)FAILUNLISTED <file>
  223.     Path to textfile to send for failed requests due to NOUNLISTED option.
  224.     Disable or set NOFAILUNLISTED if you don't wish to use this.
  225.     Ex: FAILUNLISTED Mail:GFreq/Textfiles/Unlisted.TXT
  226.  
  227.         Keyword: (NO)ONLYKNOWN
  228.     Only allow nodes listed with ALLOWNODE to make file requests.
  229.     Ex: ONLYKNOWN
  230.  
  231.         Keyword: (NO)FAILONLYKNOWN <file>
  232.     Path to textfile to send for failed requests due to ONLYKNOWN option.
  233.     Disable or set NOFAILONLYKNOWN if you don't wish to use this.
  234.     Ex: FAILONLYKNOWN Mail:GFreq/Textfiles/Security.TXT
  235.  
  236.         Keyword: EXCLUDE <node>
  237.     Forbid specified nodes from making file requests. You may use
  238.     wildcards (*).
  239.     Ex: EXCLUDE 1:234/567.8
  240.     Ex: EXCLUDE 55:100/*
  241.  
  242.         Keyword: (NO)FAILEXCLUDE <file>
  243.     Path to textfile to send for failed requests due to EXCLUDE'd node.
  244.     Disable or set NOFAILEXCLUDE if you don't wish to use this.
  245.     Ex: FAILEXCLUDE Mail:GFreq/Textfiles/Exclude.TXT
  246.  
  247.         Keyword: (NO)BEEP
  248.     Beep and flash the screen when GoldFreq starts.
  249.     Ex: BEEP
  250.  
  251.         Keyword: SCREEN <pubscreen>
  252.     Define public screen name to open status window on (WB 2.04+)
  253.     If you wish to use TrapDoor's public screen then you have to put
  254.     in "SCREENMODE PUBLIC" in TrapDoor.cfg
  255.     Ex: SCREEN TrapDoor
  256.  
  257.         Keyword: SCREENPOS <pos> <pos>
  258.     Define location of upper left corner of status window.
  259.     Ex: SCREENPOS 100 25
  260.  
  261.         Keyword: (NO)QUIET
  262.     Tell Goldfreq to be quiet and not open any window
  263.     Ex: QUIET
  264.  
  265.         Keyword: (NO)SCREENTOFRONT
  266.     Tell GoldFreq to put his screen to front. This does only work if the
  267.     option NOQUIET is selected.
  268.     Ex: SCREENTOFRONT
  269.  
  270.         Keyword: (NO)DEFCOMMENT <desc>
  271.     Define default file comment to use if GoldFreq don't find any.
  272.     Ex: DEFCOMMENT No File Description Available :-(
  273.  
  274.         Keyword: (NO)FISH
  275.     For Fish CD users: Have Gold Freq use the Fish CD style file comments.
  276.     It is one file named <file>.pi in the same directory as the actual file.
  277.     But first GoldFreq search for the AmigaDos filecomment.
  278.     Ex: FISH
  279.  
  280.         Keyword: (NO)AMINET
  281.     For those that has AmiNet. With the descriptions in a .readme file.
  282.     But first GoldFreq search for the AmigaDos filecomment.
  283.     Ex: AMINET
  284.  
  285.         Keyword: (NO)PRODUCT-INFO
  286.     If GoldFreq don't find the AmigaDos filecomment. Tell it to search for
  287.     the file Product-Info inside the archive.
  288.     Ex: PRODUCT-INFO
  289.  
  290.         Keyword: PASSDEFSEND <file>
  291.     Define a file to send with all successful file requests.
  292.     Max 6 PassDefsend's.
  293.     Ex: PASSDEFSEND Files:Lokala/Text/NewFiles.lha
  294.  
  295.         Keyword: FAILDEFSEND <file>
  296.     Define a file to send with all file requests that failed the security
  297.     check. Max 6 FailDefsend's.
  298.     Ex: FAILDEFSEND Files:Lokala/Text/BBSRules.lha
  299.  
  300.         Keyword: (NO)MAXBYTES
  301.     Set the maximum bytes allowed per file request.
  302.     Disable or set NOMAXBYTES for unlimited.
  303.     Ex: MAXBYTES 10m  (10 Mb = 10 * 1024 * 1024 bytes)
  304.     Ex: MAXBYTES 50k  (50 Kb = 50 * 1024 bytes)
  305.     Ex: MAXBYTES 500b (500 bytes)
  306.     Ex: MAXBYTES 1254 (1254 bytes)
  307.  
  308.         Keyword: (NO)MAXFILES
  309.     Set the maximum files allowed per file request.
  310.     Disable or set NOMAXFILES for unlimited.
  311.     Ex: MAXFILES 10
  312.  
  313.         Keyword: MAXLEVEL <level> FILES <files> BYTES <bytes>
  314.     Choose diferent maxbytes and maxfiles for the different userlevels.
  315.     Ex: MAXLEVEL 2 FILES 20 BYTES 10m
  316.  
  317.         Keyword: ALLOWNODE <node> [LEVEL/ONLY <level>]
  318.     Define nodes that are allowed to request files when ONLYKNOWN  mode is
  319.     active. Also allows you set access levels for nodes for use with or
  320.     without ONLYKNOWN mode.
  321.     If a node is specified under ALLOWNODES then no other security-checks
  322.     are performed for that node. You may set EXCLUDE 1:234/* to tell
  323.     GoldFreq that nodes from net 1:234 are forbid from filerequests. Then
  324.     you may specify ALLOWNODE 1:234/567.5 to tell GoldFreq that just that
  325.     special node are allowed.
  326.     You may also specify acceslevels for the nodes.
  327.     Nodes with LEVEL 5 are allowed to pick up magicfiles and files from
  328.     directorys with level 0-5.
  329.     Nodes with ONLY 6 are only allowed to pick upp magicfiles and files
  330.     from directorys with level 6.
  331.     Ex: ALLOWNODE 1:123/456.0 LEVEL 5
  332.     Ex: ALLOWNODE 1:123/456.8 ONLY 5
  333.     Ex: ALLOWNODE 2:203/319.7
  334.  
  335.         Keyword: (NO)DEFPOINTLEVEL <num>
  336.     Set default level for points not found under allownode.
  337.     Ex: DEFPOINTLEVEL 1
  338.  
  339.         Keyword: (NO)DEFNODELEVEL <num>
  340.     Set default level for nodes not found under allownode.
  341.     Ex: DEFNODELEVEL 2
  342.  
  343.         Keyword: (NO)UPDATE
  344.     Allow update requests.
  345.     File after date = +yymmdd and file before date = -yymmdd.
  346.     In the requestfile it must be writen after the filename with a space
  347.     between the filename and the date.
  348.     Ex: UPDATE
  349.  
  350.         Keyword: ALLMAGIC <name> <file>
  351.     Define magic filenames that are free for all to request. also those
  352.     nodes that normaly not are allowed to request files. Except from those
  353.     nodes that are specified under EXCLUDE.
  354.     This works only on the registered version.
  355.     Ex: ALLMAGIC NEWFILES Files:Lokala/Text/NewFiles.lha
  356.  
  357.         Keyword: MAGIC <name> <file> [<level><password>]
  358.     Define magic filenames. Optional password and access levels may be
  359.     assigned. Wildcarding is allowed in the filename in the registered version
  360.     the newest matching file will be sent.
  361.     You do not have to specify files under both MAGIC and ALLMAGIC.
  362.     Ex: MAGIC FILES Files:Local/Text/AllFiles.lha
  363.     Ex: MAGIC Spot Files:Local/Utils/spot.lha PASSWORD WHO_KNOWS LEVEL 5
  364.     Ex: MAGIC BARNEY Files:ADS/AdsFido/BARNEY* LEVEL 1
  365.     Ex: MAGIC GFreq Files:Locala/Utils/GFreq*
  366.     You can also in the registered version write multiple files with the
  367.     same MAGIC-name. Then all files with the same MAGIC-name will be sent.
  368.     Ex: MAGIC Spot Files:Lokala/Utils/SPOT13.lha
  369.     Ex: MAGIC Spot Files:Lokala/Utils/SPOT13p.lha
  370.     In this case both files will be sent.
  371.  
  372.         Keyword: DIRECTORY <dir>
  373.     Define directories for Gold Freq to search through for files to send.
  374.     You may add passwords or access levels as needed.
  375.     Ex: DIRECTORY Files:Local/Diffs
  376.     Ex: DIRECTORY Files:SKY/Shi_Tns PASSWORD Amiga LEVEL 5
  377.     Ex: DIRECTORY Files:ADS/AdsARexx LEVEL 4
  378.     Ex: DIRECTORY Files:ADS/AdsComm PASSWORD !!--
  379.  
  380.